dcmotor28fng.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2026 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef DCMOTOR28FNG_H
#define DCMOTOR28FNG_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_analog_in.h"




#define DCMOTOR28FNG_RISENSE_V_TO_MA        1.0

#define DCMOTOR28FNG_NUM_CONVERSIONS        200

#define DCMOTOR28FNG_VREF_3V3               3.3
#define DCMOTOR28FNG_VREF_5V                5.0
#define DCMOTOR28FNG_VREF_DEFAULT           DCMOTOR28FNG_VREF_3V3

#define DCMOTOR28FNG_TIMEOUT_MS             2000

#define DCMOTOR28FNG_MOTOR_COAST            0
#define DCMOTOR28FNG_MOTOR_FORWARD          1
#define DCMOTOR28FNG_MOTOR_REVERSE          2
#define DCMOTOR28FNG_MOTOR_BRAKE            3
 // dcmotor28fng_set



#define DCMOTOR28FNG_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.isense = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.sleep = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.in1 = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.in2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.fault = MIKROBUS( mikrobus, MIKROBUS_INT )
 // dcmotor28fng_map // dcmotor28fng

typedef struct
{
    digital_out_t sleep;    
    digital_out_t in1;      
    digital_out_t in2;      
 
    digital_in_t fault;     
 
    analog_in_t adc;        
 
    float zero_curr_offset; 
 
} dcmotor28fng_t;

typedef struct
{
    pin_name_t isense;      
    pin_name_t sleep;       
    pin_name_t in1;         
    pin_name_t in2;         
    pin_name_t fault;       
 
    analog_in_resolution_t resolution;  
    float                  vref;        
 
} dcmotor28fng_cfg_t;

typedef enum
{
    DCMOTOR28FNG_OK = 0,
    DCMOTOR28FNG_ERROR = -1
 
} dcmotor28fng_return_value_t;


void dcmotor28fng_cfg_setup ( dcmotor28fng_cfg_t *cfg );

err_t dcmotor28fng_init ( dcmotor28fng_t *ctx, dcmotor28fng_cfg_t *cfg );

err_t dcmotor28fng_read_adc_raw ( dcmotor28fng_t *ctx, uint16_t *data_out );

err_t dcmotor28fng_read_adc_volt ( dcmotor28fng_t *ctx, float *data_out );

err_t dcmotor28fng_read_adc_volt_avg ( dcmotor28fng_t *ctx, uint16_t num_conv, float *volt_avg );

err_t dcmotor28fng_set_adc_vref ( dcmotor28fng_t *ctx, float vref );

void dcmotor28fng_set_in1_pin ( dcmotor28fng_t *ctx );

void dcmotor28fng_clear_in1_pin ( dcmotor28fng_t *ctx );

void dcmotor28fng_set_in2_pin ( dcmotor28fng_t *ctx );

void dcmotor28fng_clear_in2_pin ( dcmotor28fng_t *ctx );

void dcmotor28fng_set_sleep_pin ( dcmotor28fng_t *ctx );

void dcmotor28fng_clear_sleep_pin ( dcmotor28fng_t *ctx );

uint8_t dcmotor28fng_get_fault_pin ( dcmotor28fng_t *ctx );

void dcmotor28fng_drive_motor ( dcmotor28fng_t *ctx, uint8_t state );

err_t dcmotor28fng_calib_offset ( dcmotor28fng_t *ctx );

err_t dcmotor28fng_get_out_current ( dcmotor28fng_t *ctx, float *current );
 
#ifdef __cplusplus
}
#endif
#endif // DCMOTOR28FNG_H
 // dcmotor28fng
 
// ------------------------------------------------------------------------ END